GET api/v1/users/current/multiFamily/automation?locationIds[0]={locationIds[0]}&locationIds[1]={locationIds[1]}

Get all the Thermostats and Locks info by given List of Locations

Request Information

URI Parameters

Name	Description	Type	Additional information
locationIds		Collection of integer	Required

Body Parameters

None.

Response Information

Resource Description

MultiFamliyAutomationDevicesInfo

Name	Type	Additional information
Thermostats	Collection of MultiFamliyThermostatInfo	None.
Locks	Collection of MultiFamliyLockInfo	None.
ResultCode	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Thermostats": [
    {
      "LocationID": 1,
      "LocationName": "sample string 2",
      "DeviceID": 3,
      "ThermostatID": 4,
      "ThermostatName": "sample string 5",
      "ThermostatIndex": 6,
      "CurrentOpMode": 7,
      "ThermostatMode": 8,
      "ThermostatFanMode": 9,
      "HeatSetPoint": 10,
      "CoolSetPoint": 11,
      "EnergySaveHeatSetPoint": 12,
      "EnergySaveCoolSetPoint": 13,
      "TemperatureScale": "sample string 14",
      "CurrentTemperture": 15,
      "BatteryState": 16,
      "FanModeList": [
        {
          "ModeID": 1
        },
        {
          "ModeID": 1
        }
      ],
      "ThermostatModeList": [
        {
          "ModeID": 1
        },
        {
          "ModeID": 1
        }
      ],
      "ThermostatSupportedOpModeList": [
        {
          "ModeID": 1
        },
        {
          "ModeID": 1
        }
      ],
      "DeviceStatusID": 64,
      "LyricUserID": 18,
      "DeviceType": 19,
      "AutoChangeOverEnabled": true,
      "TccThermostat": {
        "IndoorHumidity": 1,
        "OutdoorHumidity": 2,
        "OutdoorTemperature": 3,
        "TempHoldTime": "sample string 4",
        "IsScheduleCapable": true,
        "MinHeatSetPoint": 6,
        "MaxHeatSetPoint": 7,
        "MinCoolSetPoint": 8,
        "MaxCoolSetPoint": 9,
        "DeadbandforF": "sample string 10",
        "DeadbandforC": "sample string 11",
        "ScheduleHeatSetPoint": 12,
        "ScheduleCoolSetPoint": 13,
        "ThermostatMac": "sample string 14",
        "PartnerLocationID": "sample string 15",
        "PartnerDeviceID": "sample string 16"
      },
      "LyricThermostat": {
        "IndoorHumidity": 1,
        "OutdoorHumidity": 2,
        "OutdoorTemperature": 3,
        "TempHoldTime": "sample string 4",
        "MinHeatSetPoint": 5,
        "MaxHeatSetPoint": 6,
        "MinCoolSetPoint": 7,
        "MaxCoolSetPoint": 8,
        "DeadbandforF": "sample string 9",
        "DeadbandforC": "sample string 10",
        "ThermostatScheduleType": 11,
        "ThermostatScheduleStatus": 12
      }
    },
    {
      "LocationID": 1,
      "LocationName": "sample string 2",
      "DeviceID": 3,
      "ThermostatID": 4,
      "ThermostatName": "sample string 5",
      "ThermostatIndex": 6,
      "CurrentOpMode": 7,
      "ThermostatMode": 8,
      "ThermostatFanMode": 9,
      "HeatSetPoint": 10,
      "CoolSetPoint": 11,
      "EnergySaveHeatSetPoint": 12,
      "EnergySaveCoolSetPoint": 13,
      "TemperatureScale": "sample string 14",
      "CurrentTemperture": 15,
      "BatteryState": 16,
      "FanModeList": [
        {
          "ModeID": 1
        },
        {
          "ModeID": 1
        }
      ],
      "ThermostatModeList": [
        {
          "ModeID": 1
        },
        {
          "ModeID": 1
        }
      ],
      "ThermostatSupportedOpModeList": [
        {
          "ModeID": 1
        },
        {
          "ModeID": 1
        }
      ],
      "DeviceStatusID": 64,
      "LyricUserID": 18,
      "DeviceType": 19,
      "AutoChangeOverEnabled": true,
      "TccThermostat": {
        "IndoorHumidity": 1,
        "OutdoorHumidity": 2,
        "OutdoorTemperature": 3,
        "TempHoldTime": "sample string 4",
        "IsScheduleCapable": true,
        "MinHeatSetPoint": 6,
        "MaxHeatSetPoint": 7,
        "MinCoolSetPoint": 8,
        "MaxCoolSetPoint": 9,
        "DeadbandforF": "sample string 10",
        "DeadbandforC": "sample string 11",
        "ScheduleHeatSetPoint": 12,
        "ScheduleCoolSetPoint": 13,
        "ThermostatMac": "sample string 14",
        "PartnerLocationID": "sample string 15",
        "PartnerDeviceID": "sample string 16"
      },
      "LyricThermostat": {
        "IndoorHumidity": 1,
        "OutdoorHumidity": 2,
        "OutdoorTemperature": 3,
        "TempHoldTime": "sample string 4",
        "MinHeatSetPoint": 5,
        "MaxHeatSetPoint": 6,
        "MinCoolSetPoint": 7,
        "MaxCoolSetPoint": 8,
        "DeadbandforF": "sample string 9",
        "DeadbandforC": "sample string 10",
        "ThermostatScheduleType": 11,
        "ThermostatScheduleStatus": 12
      }
    }
  ],
  "Locks": [
    {
      "LocationID": 1,
      "LocationName": "sample string 2",
      "DeviceID": 3,
      "LockID": 4,
      "LockName": "sample string 5",
      "LockIndex": 6,
      "LockState": 7,
      "BatteryState": 8,
      "DeviceStatusID": 64,
      "DeviceTypeID": 10
    },
    {
      "LocationID": 1,
      "LocationName": "sample string 2",
      "DeviceID": 3,
      "LockID": 4,
      "LockName": "sample string 5",
      "LockIndex": 6,
      "LockState": 7,
      "BatteryState": 8,
      "DeviceStatusID": 64,
      "DeviceTypeID": 10
    }
  ],
  "ResultCode": 1
}

application/xml, text/xml

Sample:

<MultiFamliyAutomationDevicesInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.Automation">
  <Locks>
    <MultiFamliyLockInfo>
      <BatteryState>8</BatteryState>
      <DeviceID>3</DeviceID>
      <DeviceStatusID>64</DeviceStatusID>
      <DeviceTypeID>10</DeviceTypeID>
      <LocationID>1</LocationID>
      <LocationName>sample string 2</LocationName>
      <LockID>4</LockID>
      <LockIndex>6</LockIndex>
      <LockName>sample string 5</LockName>
      <LockState>7</LockState>
    </MultiFamliyLockInfo>
    <MultiFamliyLockInfo>
      <BatteryState>8</BatteryState>
      <DeviceID>3</DeviceID>
      <DeviceStatusID>64</DeviceStatusID>
      <DeviceTypeID>10</DeviceTypeID>
      <LocationID>1</LocationID>
      <LocationName>sample string 2</LocationName>
      <LockID>4</LockID>
      <LockIndex>6</LockIndex>
      <LockName>sample string 5</LockName>
      <LockState>7</LockState>
    </MultiFamliyLockInfo>
  </Locks>
  <ResultCode>1</ResultCode>
  <Thermostats>
    <MultiFamliyThermostatInfo>
      <AutoChangeOverEnabled>true</AutoChangeOverEnabled>
      <BatteryState>16</BatteryState>
      <CoolSetPoint>11</CoolSetPoint>
      <CurrentOpMode>7</CurrentOpMode>
      <CurrentTemperture>15</CurrentTemperture>
      <DeviceID>3</DeviceID>
      <DeviceStatusID>64</DeviceStatusID>
      <DeviceType>19</DeviceType>
      <EnergySaveCoolSetPoint>13</EnergySaveCoolSetPoint>
      <EnergySaveHeatSetPoint>12</EnergySaveHeatSetPoint>
      <FanModeList>
        <ModeInfo>
          <ModeID>1</ModeID>
        </ModeInfo>
        <ModeInfo>
          <ModeID>1</ModeID>
        </ModeInfo>
      </FanModeList>
      <HeatSetPoint>10</HeatSetPoint>
      <LocationID>1</LocationID>
      <LocationName>sample string 2</LocationName>
      <LyricThermostat>
        <DeadbandforC>sample string 10</DeadbandforC>
        <DeadbandforF>sample string 9</DeadbandforF>
        <IndoorHumidity>1</IndoorHumidity>
        <MaxCoolSetPoint>8</MaxCoolSetPoint>
        <MaxHeatSetPoint>6</MaxHeatSetPoint>
        <MinCoolSetPoint>7</MinCoolSetPoint>
        <MinHeatSetPoint>5</MinHeatSetPoint>
        <OutdoorHumidity>2</OutdoorHumidity>
        <OutdoorTemperature>3</OutdoorTemperature>
        <TempHoldTime>sample string 4</TempHoldTime>
        <ThermostatScheduleStatus>12</ThermostatScheduleStatus>
        <ThermostatScheduleType>11</ThermostatScheduleType>
      </LyricThermostat>
      <LyricUserID>18</LyricUserID>
      <TccThermostat>
        <DeadbandforC>sample string 11</DeadbandforC>
        <DeadbandforF>sample string 10</DeadbandforF>
        <IndoorHumidity>1</IndoorHumidity>
        <IsScheduleCapable>true</IsScheduleCapable>
        <MaxCoolSetPoint>9</MaxCoolSetPoint>
        <MaxHeatSetPoint>7</MaxHeatSetPoint>
        <MinCoolSetPoint>8</MinCoolSetPoint>
        <MinHeatSetPoint>6</MinHeatSetPoint>
        <OutdoorHumidity>2</OutdoorHumidity>
        <OutdoorTemperature>3</OutdoorTemperature>
        <PartnerDeviceID>sample string 16</PartnerDeviceID>
        <PartnerLocationID>sample string 15</PartnerLocationID>
        <ScheduleCoolSetPoint>13</ScheduleCoolSetPoint>
        <ScheduleHeatSetPoint>12</ScheduleHeatSetPoint>
        <TempHoldTime>sample string 4</TempHoldTime>
        <ThermostatMac>sample string 14</ThermostatMac>
      </TccThermostat>
      <TemperatureScale>sample string 14</TemperatureScale>
      <ThermostatFanMode>9</ThermostatFanMode>
      <ThermostatID>4</ThermostatID>
      <ThermostatIndex>6</ThermostatIndex>
      <ThermostatMode>8</ThermostatMode>
      <ThermostatModeList>
        <ModeInfo>
          <ModeID>1</ModeID>
        </ModeInfo>
        <ModeInfo>
          <ModeID>1</ModeID>
        </ModeInfo>
      </ThermostatModeList>
      <ThermostatName>sample string 5</ThermostatName>
      <ThermostatSupportedOpModeList>
        <ModeInfo>
          <ModeID>1</ModeID>
        </ModeInfo>
        <ModeInfo>
          <ModeID>1</ModeID>
        </ModeInfo>
      </ThermostatSupportedOpModeList>
    </MultiFamliyThermostatInfo>
    <MultiFamliyThermostatInfo>
      <AutoChangeOverEnabled>true</AutoChangeOverEnabled>
      <BatteryState>16</BatteryState>
      <CoolSetPoint>11</CoolSetPoint>
      <CurrentOpMode>7</CurrentOpMode>
      <CurrentTemperture>15</CurrentTemperture>
      <DeviceID>3</DeviceID>
      <DeviceStatusID>64</DeviceStatusID>
      <DeviceType>19</DeviceType>
      <EnergySaveCoolSetPoint>13</EnergySaveCoolSetPoint>
      <EnergySaveHeatSetPoint>12</EnergySaveHeatSetPoint>
      <FanModeList>
        <ModeInfo>
          <ModeID>1</ModeID>
        </ModeInfo>
        <ModeInfo>
          <ModeID>1</ModeID>
        </ModeInfo>
      </FanModeList>
      <HeatSetPoint>10</HeatSetPoint>
      <LocationID>1</LocationID>
      <LocationName>sample string 2</LocationName>
      <LyricThermostat>
        <DeadbandforC>sample string 10</DeadbandforC>
        <DeadbandforF>sample string 9</DeadbandforF>
        <IndoorHumidity>1</IndoorHumidity>
        <MaxCoolSetPoint>8</MaxCoolSetPoint>
        <MaxHeatSetPoint>6</MaxHeatSetPoint>
        <MinCoolSetPoint>7</MinCoolSetPoint>
        <MinHeatSetPoint>5</MinHeatSetPoint>
        <OutdoorHumidity>2</OutdoorHumidity>
        <OutdoorTemperature>3</OutdoorTemperature>
        <TempHoldTime>sample string 4</TempHoldTime>
        <ThermostatScheduleStatus>12</ThermostatScheduleStatus>
        <ThermostatScheduleType>11</ThermostatScheduleType>
      </LyricThermostat>
      <LyricUserID>18</LyricUserID>
      <TccThermostat>
        <DeadbandforC>sample string 11</DeadbandforC>
        <DeadbandforF>sample string 10</DeadbandforF>
        <IndoorHumidity>1</IndoorHumidity>
        <IsScheduleCapable>true</IsScheduleCapable>
        <MaxCoolSetPoint>9</MaxCoolSetPoint>
        <MaxHeatSetPoint>7</MaxHeatSetPoint>
        <MinCoolSetPoint>8</MinCoolSetPoint>
        <MinHeatSetPoint>6</MinHeatSetPoint>
        <OutdoorHumidity>2</OutdoorHumidity>
        <OutdoorTemperature>3</OutdoorTemperature>
        <PartnerDeviceID>sample string 16</PartnerDeviceID>
        <PartnerLocationID>sample string 15</PartnerLocationID>
        <ScheduleCoolSetPoint>13</ScheduleCoolSetPoint>
        <ScheduleHeatSetPoint>12</ScheduleHeatSetPoint>
        <TempHoldTime>sample string 4</TempHoldTime>
        <ThermostatMac>sample string 14</ThermostatMac>
      </TccThermostat>
      <TemperatureScale>sample string 14</TemperatureScale>
      <ThermostatFanMode>9</ThermostatFanMode>
      <ThermostatID>4</ThermostatID>
      <ThermostatIndex>6</ThermostatIndex>
      <ThermostatMode>8</ThermostatMode>
      <ThermostatModeList>
        <ModeInfo>
          <ModeID>1</ModeID>
        </ModeInfo>
        <ModeInfo>
          <ModeID>1</ModeID>
        </ModeInfo>
      </ThermostatModeList>
      <ThermostatName>sample string 5</ThermostatName>
      <ThermostatSupportedOpModeList>
        <ModeInfo>
          <ModeID>1</ModeID>
        </ModeInfo>
        <ModeInfo>
          <ModeID>1</ModeID>
        </ModeInfo>
      </ThermostatSupportedOpModeList>
    </MultiFamliyThermostatInfo>
  </Thermostats>
</MultiFamliyAutomationDevicesInfo>